home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / chegv.z / chegv
Encoding:
Text File  |  2002-10-03  |  6.4 KB  |  199 lines
  1.  
  2.  
  3.  
  4. CCCCHHHHEEEEGGGGVVVV((((3333SSSS))))                                                            CCCCHHHHEEEEGGGGVVVV((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CHEGV - compute all the eigenvalues, and optionally, the eigenvectors of
  10.      a complex generalized Hermitian-definite eigenproblem, of the form
  11.      A*x=(lambda)*B*x, A*Bx=(lambda)*x, or B*A*x=(lambda)*x
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE CHEGV( ITYPE, JOBZ, UPLO, N, A, LDA, B, LDB, W, WORK, LWORK,
  15.                        RWORK, INFO )
  16.  
  17.          CHARACTER     JOBZ, UPLO
  18.  
  19.          INTEGER       INFO, ITYPE, LDA, LDB, LWORK, N
  20.  
  21.          REAL          RWORK( * ), W( * )
  22.  
  23.          COMPLEX       A( LDA, * ), B( LDB, * ), WORK( * )
  24.  
  25. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  26.      These routines are part of the SCSL Scientific Library and can be loaded
  27.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  28.      directs the linker to use the multi-processor version of the library.
  29.  
  30.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  31.      4 bytes (32 bits). Another version of SCSL is available in which integers
  32.      are 8 bytes (64 bits).  This version allows the user access to larger
  33.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  34.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  35.      only one of the two versions; 4-byte integer and 8-byte integer library
  36.      calls cannot be mixed.
  37.  
  38. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  39.      CHEGV computes all the eigenvalues, and optionally, the eigenvectors of a
  40.      complex generalized Hermitian-definite eigenproblem, of the form
  41.      A*x=(lambda)*B*x, A*Bx=(lambda)*x, or B*A*x=(lambda)*x. Here A and B are
  42.      assumed to be Hermitian and B is also
  43.      positive definite.
  44.  
  45.  
  46. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  47.      ITYPE   (input) INTEGER
  48.              Specifies the problem type to be solved:
  49.              = 1:  A*x = (lambda)*B*x
  50.              = 2:  A*B*x = (lambda)*x
  51.              = 3:  B*A*x = (lambda)*x
  52.  
  53.      JOBZ    (input) CHARACTER*1
  54.              = 'N':  Compute eigenvalues only;
  55.              = 'V':  Compute eigenvalues and eigenvectors.
  56.  
  57.      UPLO    (input) CHARACTER*1
  58.              = 'U':  Upper triangles of A and B are stored;
  59.              = 'L':  Lower triangles of A and B are stored.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCHHHHEEEEGGGGVVVV((((3333SSSS))))                                                            CCCCHHHHEEEEGGGGVVVV((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      N       (input) INTEGER
  75.              The order of the matrices A and B.  N >= 0.
  76.  
  77.      A       (input/output) COMPLEX array, dimension (LDA, N)
  78.              On entry, the Hermitian matrix A.  If UPLO = 'U', the leading N-
  79.              by-N upper triangular part of A contains the upper triangular
  80.              part of the matrix A.  If UPLO = 'L', the leading N-by-N lower
  81.              triangular part of A contains the lower triangular part of the
  82.              matrix A.
  83.  
  84.              On exit, if JOBZ = 'V', then if INFO = 0, A contains the matrix Z
  85.              of eigenvectors.  The eigenvectors are normalized as follows:  if
  86.              ITYPE = 1 or 2, Z**H*B*Z = I; if ITYPE = 3, Z**H*inv(B)*Z = I.
  87.              If JOBZ = 'N', then on exit the upper triangle (if UPLO='U') or
  88.              the lower triangle (if UPLO='L') of A, including the diagonal, is
  89.              destroyed.
  90.  
  91.      LDA     (input) INTEGER
  92.              The leading dimension of the array A.  LDA >= max(1,N).
  93.  
  94.      B       (input/output) COMPLEX array, dimension (LDB, N)
  95.              On entry, the Hermitian positive definite matrix B.  If UPLO =
  96.              'U', the leading N-by-N upper triangular part of B contains the
  97.              upper triangular part of the matrix B.  If UPLO = 'L', the
  98.              leading N-by-N lower triangular part of B contains the lower
  99.              triangular part of the matrix B.
  100.  
  101.              On exit, if INFO <= N, the part of B containing the matrix is
  102.              overwritten by the triangular factor U or L from the Cholesky
  103.              factorization B = U**H*U or B = L*L**H.
  104.  
  105.      LDB     (input) INTEGER
  106.              The leading dimension of the array B.  LDB >= max(1,N).
  107.  
  108.      W       (output) REAL array, dimension (N)
  109.              If INFO = 0, the eigenvalues in ascending order.
  110.  
  111.      WORK    (workspace/output) COMPLEX array, dimension (LWORK)
  112.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  113.  
  114.      LWORK   (input) INTEGER
  115.              The length of the array WORK.  LWORK >= max(1,2*N-1).  For
  116.              optimal efficiency, LWORK >= (NB+1)*N, where NB is the blocksize
  117.              for CHETRD returned by ILAENV.
  118.  
  119.              If LWORK = -1, then a workspace query is assumed; the routine
  120.              only calculates the optimal size of the WORK array, returns this
  121.              value as the first entry of the WORK array, and no error message
  122.              related to LWORK is issued by XERBLA.
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCHHHHEEEEGGGGVVVV((((3333SSSS))))                                                            CCCCHHHHEEEEGGGGVVVV((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      RWORK   (workspace) REAL array, dimension (max(1, 3*N-2))
  141.  
  142.      INFO    (output) INTEGER
  143.              = 0:  successful exit
  144.              < 0:  if INFO = -i, the i-th argument had an illegal value
  145.              > 0:  CPOTRF or CHEEV returned an error code:
  146.              <= N:  if INFO = i, CHEEV failed to converge; i off-diagonal
  147.              elements of an intermediate tridiagonal form did not converge to
  148.              zero; > N:   if INFO = N + i, for 1 <= i <= N, then the leading
  149.              minor of order i of B is not positive definite.  The
  150.              factorization of B could not be completed and no eigenvalues or
  151.              eigenvectors were computed.
  152.  
  153. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  154.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  155.  
  156.      This man page is available only online.
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.